Finance APIs
VAT posting details for provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/finance/vat-postings/{vatPostingId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {vatPostingId} |
VAT Posting identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2230, version 11 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
VATPostingId
VAT Posting identifier
>{Integer}</VATPostingId>Status
Status of VAT posting
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Date
Date of VAT posting. Currency rate calculation use this date.
>{Date}</Date>VATPeriod
Accounting period this VAT posting belongs to
>{Integer}</VATPeriod>OriginalVATPeriod
Original accounting period of VAT posting before VAT is postponed
>{Integer}</OriginalVATPeriod>IsPostponed
Indicates if a VAT posting is postponed
>{Boolean}</IsPostponed>VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
>{Decimal}</VATRate>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
>{String}</VATRegistrationNumber>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Country
Country name of VAT entity
>{String}</Country>CountryCode
Country code of VAT Entity
>{String}</CountryCode>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Date
Date when the document was issued.
>{Date}</Date>RegistrationDate
Date of registration
>{Date}</RegistrationDate>AccountingPeriod
The accounting period the object belongs to
>{Integer}</AccountingPeriod>ObjectLink
API reference to the object
>{String}</ObjectLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Name
Name of the customer/supplier, or last name if it is a person.
>{String}</Name>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
>{String}</VATRegistrationNumber>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ItemLink
API reference to the item
>{String}</ItemLink>ReportedDate
Date of latest VAT reporting
>{Date}</ReportedDate>ReportedBy
Employee who stated that latest reporting was completed
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>FirstName
First name of employee
>{String}</FirstName>LastName
Last name of employee
>{String}</LastName>EmployeeLink
Employee reference
>{String}</EmployeeLink>VATPostingId
VAT Posting identifier
": "{Integer}",Status
Status of VAT posting
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Date
Date of VAT posting. Currency rate calculation use this date.
": "{Date}",VATPeriod
Accounting period this VAT posting belongs to
": "{Integer}",OriginalVATPeriod
Original accounting period of VAT posting before VAT is postponed
": "{Integer}",IsPostponed
Indicates if a VAT posting is postponed
": "{Boolean}",VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
": "{Decimal}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",Country
Country name of VAT entity
": "{String}",CountryCode
Country code of VAT Entity
": "{String}"ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",Date
Date when the document was issued.
": "{Date}",RegistrationDate
Date of registration
": "{Date}",AccountingPeriod
The accounting period the object belongs to
": "{Integer}"ObjectLink
API reference to the object
": "{String}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Name
Name of the customer/supplier, or last name if it is a person.
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
": "{String}",ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}"ReportedDate
Date of latest VAT reporting
": "{Date}",ReportedBy
Employee who stated that latest reporting was completed
": {EmployeeId
Employee identifier
": "{Integer}",FirstName
First name of employee
": "{String}",LastName
Last name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100050 HTTP 403 | No admittance as customer {0} |
| Error 100053 HTTP 403 | You have only admittance to your own suppliers |